home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Vk / VkMenuUndoManager.z / VkMenuUndoManager
Encoding:
Text File  |  1998-10-20  |  9.0 KB  |  199 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkMMMMeeeennnnuuuuUUUUnnnnddddooooMMMMaaaannnnaaaaggggeeeerrrr((((3333xxxx))))                                    VVVVkkkkMMMMeeeennnnuuuuUUUUnnnnddddooooMMMMaaaannnnaaaaggggeeeerrrr((((3333xxxx))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkMenuUndoManager - Support for an undo facility
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      VkMenuAction : VkMenuItem : VkComponent : VkCallbackObject
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <Vk/VkMenuItem.h>
  16.  
  17.  
  18. PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  19.    CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
  20.            VkMenuUndoManager(const char *, XtCallbackProc, XtPointer);
  21.            ~VkMenuUndoManager();
  22.  
  23.  
  24.    MMMMaaaannnniiiippppuuuullllaaaattttiiiinnnngggg MMMMeeeennnnuuuu IIIItttteeeemmmmssss
  25.            virtual void undo();
  26.  
  27.  
  28.    AAAAcccccccceeeessssssss FFFFuuuunnnnccccttttiiiioooonnnnssss
  29.            virtual const char* className();
  30.            virtual VkMenuItemType menuType ();
  31.            Boolean hasUndo()
  32.  
  33.  
  34. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  35.      This class support undoable commands in the ViewKit. Application actions
  36.      can be registered with the undo manager along with a function to be
  37.      called to undo the operation. If an instance of VkMenuUndoManager is
  38.      added to a menu, the menu automatically reflects the last undoable
  39.      command to be registered. Menu actions that have undo callbacks provided
  40.      automatically register with the undo manager.  Applications can also
  41.      register functions or use the VkAction class to support undoable
  42.      operations outside the menu system.
  43.  
  44.      Applications should not directly instantiate a VkMenuUndoManager object.
  45.      This object is instantiated automatically, and can be referenced by
  46.      including VkMenuItem.h and referencing _t_h_e_U_n_d_o_M_a_n_a_g_e_r.
  47.  
  48. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  49.    VVVVkkkkMMMMeeeennnnuuuuUUUUnnnnddddooooMMMMaaaannnnaaaaggggeeeerrrr
  50.            VkMenuUndoManager(const char * name);
  51.  
  52.  
  53.           Initialize a VkMenuUndoManager object. Objects are not normally
  54.           instantiated by applications directly.
  55.  
  56.    ~~~~VVVVkkkkMMMMeeeennnnuuuuUUUUnnnnddddooooMMMMaaaannnnaaaaggggeeeerrrr
  57.            ~VkMenuUndoManager();
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkMMMMeeeennnnuuuuUUUUnnnnddddooooMMMMaaaannnnaaaaggggeeeerrrr((((3333xxxx))))                                    VVVVkkkkMMMMeeeennnnuuuuUUUUnnnnddddooooMMMMaaaannnnaaaaggggeeeerrrr((((3333xxxx))))
  71.  
  72.  
  73.  
  74.           Clean up when a VkMenuUndoManager object is destroyed.
  75.           VkMenuUndoManager objects are not normally deleted by applications.
  76.  
  77.    rrrreeeesssseeeetttt
  78.            void reset();
  79.  
  80.  
  81.           Clear all actions registered with the undo manager.
  82.  
  83.    aaaadddddddd
  84.            void add(VkMenuAction *menuObject);
  85.            void add(const char *name,
  86.                           XtCallbackProc undocallback,
  87.                           XtPointer clientData);
  88.  
  89.  
  90.           Registers an action with the undo manager. The first form is used
  91.           automatically by the other menu classes when an undoable action is
  92.           executed. The second form may be used by applications. The first
  93.           argument is a name for the action, to appear in the the undo menu
  94.           item, if it is present in a menu. The callback must be an Xt-style
  95.           callback function to be called to undo the action, while the final
  96.           argument supplies any data to be passed to the callback function
  97.           when it is invoked.
  98.  
  99.    mmmmuuuullllttttiiiiLLLLeeeevvvveeeellll
  100.              void multiLevel(Boolean flag)
  101.  
  102.  
  103.           If _f_l_a_g is TRUE, the undo manager will allow multiple levels of
  104.           undo. Commands are kept in a stack. Undoing one command pops it from
  105.           the stack, revealing the previously executed command. Once a user
  106.           has undone one command, executing any new command clears the undo
  107.           stack.  If _f_l_a_g is FALSE, only the most recent command is
  108.           remembered.  In either case, executing any undoable command from the
  109.           menu always clears the undo stack. Applications can also explicitly
  110.           clear the stack using _r_e_s_e_t().
  111.  
  112.    hhhhiiiissssttttoooorrrryyyyLLLLiiiisssstttt
  113.              VkComponentList *historylist()
  114.  
  115.  
  116.           Returns a list of objects representing commands that have been
  117.           executed and that are currently available to be undone. The objects
  118.           will all be subclasses of VkMenuItem. Actions registered explicitly
  119.           or using VkAction objects will be returned as VkMenuActionStub
  120.           objects.  VkMenuActionStub is an empty subclass of VkMenuAction.
  121.  
  122.    ccccllllaaaassssssssNNNNaaaammmmeeee
  123.               virtual const char* className();
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. VVVVkkkkMMMMeeeennnnuuuuUUUUnnnnddddooooMMMMaaaannnnaaaaggggeeeerrrr((((3333xxxx))))                                    VVVVkkkkMMMMeeeennnnuuuuUUUUnnnnddddooooMMMMaaaannnnaaaaggggeeeerrrr((((3333xxxx))))
  137.  
  138.  
  139.  
  140.           Returns "VkMenuUndoManager"
  141.  
  142.    mmmmeeeennnnuuuuTTTTyyyyppppeeee
  143.               virtual VkMenuItemType menuType ();
  144.  
  145.  
  146.           Returns VkMenuItem::ACTION.
  147.  
  148. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  149.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkMMMMeeeennnnuuuuAAAAccccttttiiiioooonnnn
  150.           menuType(), hasUndo(),  _undoCallback, _func,  _data,
  151.  
  152.  
  153.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkMMMMeeeennnnuuuuIIIItttteeeemmmm
  154.           show(), hide(), , manageAll(), setLabel(), setPosition(),
  155.           activate(), deactivate(), remove(), show(), isContainer(),
  156.           _position, _isBuilt, _sensitive, _parentMenu, _label, _isHidden,
  157.           _unmanagedWidgets, _numUnmanagedWidgets,
  158.  
  159.  
  160.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt
  161.           installDestroyHandler(), removeDestroyHandler(), widgetDestroyed(),
  162.           setDefaultResources(), getResources(), manage(), unmanage(),
  163.           baseWidget(), okToQuit(), _name, _baseWidget, _w, deleteCallback
  164.  
  165.  
  166.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCaaaallllllllbbbbaaaacccckkkkOOOObbbbjjjjeeeecccctttt
  167.           callCallbacks(), addCallback(), removeCallback(),
  168.           removeAllCallbacks()
  169.  
  170.  
  171. CCCCLLLLAAAASSSSSSSSEEEESSSS UUUUSSSSEEEEDDDD BBBBYYYY TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  172.      VkComponent, VkComponentList, VkMenuAction, VkMenuItem
  173.  
  174. KKKKNNNNOOOOWWWWNNNN CCCCLLLLAAAASSSSSSSSEEEESSSS TTTTHHHHAAAATTTT UUUUSSSSEEEE TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  175.      VkAction
  176.  
  177. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  178.      VkMenuAction, VkMenuItem, VkComponent, VkAction, VkComponentList
  179.      _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
  180.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
  181.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
  182.      _T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.